Address Lookup API

1.0.x
(1 review)

Test Cases

Test Case API Endpoint Suggested Test Case Expected Result
1 Auto Fuzzy Complete Retrieve matching addresses by supplying a search term using auto-complete logic where the request returns matches. Using auto-complete logic, if the pageSize query parameter is not specified then the results json array, of up to 5 address matches, will be returned otherwise will be limited up to the specified valid pageSize value.

Each record in the results array will contain:

  • the formatted address label that matched the search term
  • the address id (aid)
  • the URL to retrieve the address details.
If a paginated response is requested via specifying the page query parameter, pagination links will be provided using HATEOAS. The HTTP status code may be a 200 (OK) or a 203. A 203 would be returned if the response has been cached by the API for faster response times.
2 Auto Fuzzy Complete Retrieve matching addresses by supplying a search term using fuzzy-complete logic where the request returns matches. Using fuzzy-complete logic, if the pageSize query parameter is not specified then the results and/or suggestions json array, of up to 5 address matches, will be returned otherwise will be limited up to the specified valid pageSize value.

Each record in the results array will contain:

  • the formatted address label that matched the search term
  • the address id (aid)
  • the URL to retrieve the address details.
If a paginated response is requested via specifying the page query parameter, pagination links will be provided using HATEOAS. The HTTP status code may be a 200 (OK) or a 203. A 203 would be returned if the response has been cached by the API for faster response times.
3 Auto Fuzzy Complete Retrieve matching addresses by supplying a search term using auto-complete logic where the request does not return matches. An empty results array will be returned. The HTTP status code will be a 200 (OK).
4 Auto Fuzzy Complete Retrieve matching addresses by supplying a search term using fuzzy-complete logic where the request does not return matches. An empty results and suggestions json array will be returned. The HTTP status code will be a 200 (OK).
5 Address Details Retrieve address details by supplying a valid TLC identifier. Address details are returned. The HTTP status code may be a 200 (OK) or a 203. A 203 would be returned if the response has been cached by the API for faster response times.
6 Address Details Retrieve address details by supplying a valid PLSAM identifier. Address details are returned. The HTTP status code may be a 200 (OK) or a 203. A 203 would be returned if the response has been cached by the API for faster response times.
7 Address Details Retrieve address details by supplying a valid TUI identifier. Address details are returned. The HTTP status code may be a 200 (OK) or a 203. A 203 would be returned if the response has been cached by the API for faster response times.
8 Address Details Retrieve address details by supplying a valid AID identifier. Address details are returned. The HTTP status code may be a 200 (OK) or a 203. A 203 would be returned if the response has been cached by the API for faster response times.
9 Address Details Retrieve matching addresses using auto-complete logic or fuzzy-complete logic where a query parameter is invalid (e.g. pageSize greater than 20). An HTTP status code other than 200 or 203 is returned. Please refer to Error Codes for the specific error response payload.
10 Address Details Retrieve address details by supplying an invalid identifier. An HTTP status code other than 200 or 203 is returned. Please refer to Error Codes for the specific error response payload.

Reviews